一、XLinkUserManager
用户信息管理类,用于管理当前用户信息,及相关的一些监听接口。
- 以下方法说明中明确提供不推荐使用的方法,即为不建议开发者调用或者是开发者不应该进行任何数据修改。
- 以下文档中未提及的方法均属于不推荐使用的方法
1.1. Reference
以下为此类中关联的Class及相关说明
类名 | 类型 | 说明 |
---|---|---|
XLinkUser | 实体类 | 用户信息类,详情请参考API-XLinkUser |
XLinkAuthProvider | 接口 | 用户授权信息处理接口,详情查看API-XLinkUser相关类 |
1.2. Field
以下为此类中的常用字段及说明。
1.2.1. Attributes
由于此类包含的属性较多,不一一罗列其属性的getter/setter
方法,以下字段都支持对应的方法,方法列表中不再赘述。大部分情况下,以下属性为仅读属性
字段名 | 字段类型 | getter支持返回null | 说明 |
---|---|---|---|
user | XLinkUser | 是 | 用户缓存信息,用户信息有效时不返回 null |
listener | XLinkUserListener | 是 | 用户登录状态变更回调接口 |
1.3. Methods
以下方法为开发过程常用的方法说明,参数说明及返回值说明。此处仅提供了推荐开发者使用及可能需要使用的方法,部分未列出方法请根据实际情况评估调用。
1.3.1. checkUserId
public static int checkUserId(int userId)
方法说明:
静态方法
,检测提供的用户信息是否有效,若无效时,返回当前缓存的用户ID,
注意当前的用户ID也可能是无效的ID,不一定是有效的。此方法不会通过云端进行用户ID的检测,仅本地缓存信息检测,检测原则是用户ID不可能为0或非负数。
- 若输入的用户ID为合法规则的用户ID,则会返回输入参数的用户ID;
- 若输入的用户ID为非法(如0),则返回 XAPP SDK 当前缓存的用户ID;
当前用户ID可能无效的原因是,该方法为静态方法,当不进行任何的登录操作时该方法也是可用的;此时本地不可能存在用户的缓存信息,自然也不可能返回有效的用户ID。建议此方法仅用于快速过滤或检测来自外部的用户ID参数是否为当前用户ID。
- 参数说明:
参数名 | 类型 | 说明 |
---|---|---|
userId | int | 用户ID |
- 返回值:int,用户ID;返回当前用户的ID信息
1.3.2. getUser
public XLinkUser getUser()
- 方法说明:获取当前用户信息;除此方法外,XLinkUserManager 还同时提供了 XLinkUser 的所有方法,用于方便地直接获取当前用户信息的某些信息,XLinkUserManager 实现了 XLinkAuthProvider 接口
- 返回值:XLinkUser,用户信息;可能返回 null
1.3.3. setUser
public void setUser(XLinkUser user)
- 方法说明:设置用户对象;一般情况下都不应该使用此方法,如果在 SDK 运行期间强制更新用户信息时,可能会导致很多接口无法正常使用。不推荐使用
二、更新日志
日期 | 更新内容 |
---|---|
2019-01-29 | 更新检测用户ID方法说明,避免方法描述模糊误解 |
2018-08-26 | 初稿,自 X-MQTT SDK v6.2版本起 |